home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / os2 / epmgcc10.zip / epro.doc < prev    next >
Text File  |  1994-01-30  |  5KB  |  123 lines
  1.                             EditProject Version 0.60
  2.  
  3.                           Makefile maintenance utility
  4.  
  5.                                Bernhard Bablok
  6.  
  7.                                 January, 1994
  8. Legal stuff:
  9. ~~~~~~~~~~~
  10. See the file license.txt.
  11.  
  12.  
  13. Requirements:
  14. ~~~~~~~~~~~~
  15. EditProject requires VREXX (Visual REXX), a package of external functions adding
  16. "PM"-support to REXX. VREXX is IBM employee written software and available free
  17. of charge from various ftp-sites (look for a file called vrexx2.zip).
  18.  
  19.  
  20. Introduction:
  21. ~~~~~~~~~~~~
  22. EditProject is a VREXX-script designed to maintain makefiles.  It can be used
  23. stand alone or together with EPMGCC, the EPM-interface to gcc.  The script
  24. allows you to add and delete files to be included in a project and to specify
  25. compile and link options. Dependencies to non-system include-files are
  26. automatically recognized. The output of EditProject is a makefile to be used
  27. with GNU-make (I use the port available with gcc/2).
  28.  
  29.  
  30. Installation:
  31. ~~~~~~~~~~~~
  32. Follow the instructions given in the VREXX-package to install VREXX (very
  33. simple). Then, copy epro.cmd to a directory in your PATH. If you made any
  34. changes to your config.sys, reboot your system.
  35.  
  36.  
  37. Usage:
  38. ~~~~~
  39. Just type  epro  or  epro <filename>  at an OS2-prompt. A master menu with
  40. radio buttons pops up. Possible choices:
  41.  
  42.   - Select project   Select a makefile.  ".emx" is the default extension.  Use
  43.                      ".gcc" as the extension for gcc/2.  No or any other
  44.                      extension will have the same effect as ".emx" (important
  45.                      for the generation of oject-files:  EMX generates .o or
  46.                      .obj files, gcc/2 only .obj files).
  47.  
  48.   - Add files        Add source files to the project. If fileA.c has a include
  49.                      statement like #include "fileB.h", then fileB.h will be
  50.                      included in the dependencies for fileA.o.
  51.                      Double click on a file or select "OK" to add a file. Select
  52.                      "CANCEL" to leave.
  53.                      The source files are displayed left of a standard file-box.
  54.                      Since VREXX only knows modal entry-boxes, I have to use an
  55.                      output-window (without paging support). If many files are
  56.                      added, they might not show up even though they are added.
  57.                      Files can only be added once.
  58.  
  59.   - Delete files     Displays a listbox with all files belonging to the project.
  60.                      Pressing "OK" will delete the selected file from the list
  61.                      of files. Select "CANCEL" to leave.
  62.  
  63.   - Build option     Defines debug or production mode as default mode for
  64.                      builds.
  65.  
  66.   - Compiler options Define global, debug and production options.
  67.  
  68.   - Link options     Define link options (like additional files, libraries etc.)
  69.  
  70.   - Save project     Write generated makefile to disk. If you stop epro after
  71.                      changing anything, epro will prompt you if changes should
  72.                      be saved. Therefore this option is somewhat obsolete.
  73.  
  74.   - Make             Invoke make with the current makefile and the build option
  75.                      in effect.
  76.  
  77.  
  78. Limitations:
  79. ~~~~~~~~~~~
  80. Due to a bug in VREXX, only one VREXX-script can be run at a time. Under certain
  81. circumstances, VREXX-cleanup doesn't work as expected if a VREXX-script
  82. crashes. In this case the process running vrexx.exe (use PSTAT|FIND /i "vrexx")
  83. has to be killed manually.
  84.  
  85. At the moment, EditProject supports only the generation of makefiles for
  86. executable files. A later version will include support for archive files (used
  87. with ar), DLLs and PM-applications.
  88.  
  89. I also plan to write a true PM-application with comparable functionality, but
  90. this will take some time.
  91.  
  92.  
  93. Changing the code:
  94. ~~~~~~~~~~~~~~~~~
  95. I have not tested EditProject with other resolutions than SVGA.  If you have
  96. problems with the size of the add-file box and/or delete-file box, you might try
  97. changing the variables
  98.  
  99.    sources.diff          (the space between listed files)
  100.    DeleteFiles.hight     (sets number of lines in delete-file listbox).
  101.  
  102. If you don't use gcc or make, you will have to change the variables
  103.  
  104.    EditProject.compiler
  105.    EditProject.make
  106.  
  107. to whatever values necessary (you might also have to change the translation of
  108. '\' to '/' in pathnames, see routine "ExecuteMakeFile" in epro.cmd).
  109.  
  110.  
  111. Disclaimer:
  112. ~~~~~~~~~~
  113. If you think you have found a genuine bug, or would like to make suggestions,
  114. contributions, or enhancements to this code please drop me a note.  Since I have
  115. released this code without charge, I cannot offer a warranty or customer
  116. support.
  117.  
  118.  
  119. 1/30/94
  120. Bernhard Bablok
  121. D-82256 Fuerstenfeldbruck, Germany
  122. INTERNET: ua302cb@sunmail.lrz-muenchen.de
  123.